/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered <https://www.spongepowered.org>
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.event.world.chunk;

import org.spongepowered.api.event.Cancellable;
import org.spongepowered.api.world.Chunk;
import org.spongepowered.api.world.gen.Populator;

import java.util.List;

public interface PopulateChunkEvent extends TargetChunkEvent {

    /**
     * Called before a chunk begins populating.
     */
    interface Pre extends PopulateChunkEvent {

        /**
         * Returns a mutable list of all pending populators.
         *
         * @return The populators
         */
        List<Populator> getPendingPopulators();

    }

    /**
     * Called when a populator is about to run against a chunk.
     */
    interface Populate extends PopulateChunkEvent, Cancellable {

        /**
         * Gets the populator which is about to be run.
         * 
         * @return The populator
         */
        Populator getPopulator();

    }

    /**
     * Called when a chunk finishes populating.
     */
    interface Post extends PopulateChunkEvent {

        /**
         * Returns a copy of the {@link Populator}s that ran
         * on this {@link Chunk}.
         *
         * @return The populators
         */
        List<Populator> getAppliedPopulators();
        
    }

}
